Inside Macintosh: QuickDraw GX Objects /

Chapter 7 - View-Related Objects / View-Related Objects Reference

View Port Functions / Manipulating View Port Object Properties

GXGetViewPortClip

You can use the GXGetViewPortClip function to examine the clip property of a view port object.

gxShape GXGetViewPortClip(gxViewPort source);

source

A reference to the view port whose clip you wish to examine.

function result

A reference to a newly created shape object that is a copy of the source view port's clip.

DESCRIPTION

The GXGetViewPortClip function returns a shape object whose geometry defines the clip associated with the view port. The function returns nil if there is no clip. The clip shape is a copy of the view port's clip; changing this shape does not change the view port's clip.

SPECIAL CONSIDERATIONS

If no error occurs, the GXGetViewPortClip function creates a shape object; you are responsible for disposing of that object when you no longer need it.

ERRORS, WARNINGS, AND NOTICES

Errors
out_of_memory
invalid_viewPort_reference

SEE ALSO

For an example of the use of this function, see Listing 7-3 on page 7-45.

To set the view port's clip, use the GXSetViewPortClip function, described next.